/*
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.appium.java_client.android.options.context;

import io.appium.java_client.remote.options.BaseOptions;
import io.appium.java_client.remote.options.CanSetCapability;
import org.openqa.selenium.Capabilities;

import java.util.List;
import java.util.Optional;

public interface SupportsChromedriverPortsOption<T extends BaseOptions<T>> extends
        Capabilities, CanSetCapability<T> {
    String CHROMEDRIVER_PORTS_OPTION = "chromedriverPorts";

    /**
     * Array of possible port numbers to assign for Chromedriver communication.
     * If none of the port in this array is free then a server error is thrown.
     *
     * @param ports one or more port numbers in range 0..65535
     * @return self instance for chaining.
     */
    default T setChromedriverPorts(List<Integer> ports) {
        return amend(CHROMEDRIVER_PORTS_OPTION, ports);
    }

    /**
     * Get the local port number to use for Chromedriver communication.
     *
     * @return Port number.
     */
    default Optional<List<Integer>> getChromedriverPorts() {
        //noinspection unchecked
        return Optional.ofNullable((List<Integer>) getCapability(CHROMEDRIVER_PORTS_OPTION));
    }
}
